home *** CD-ROM | disk | FTP | other *** search
/ InterCD 2000 July / july_2000.iso / Site Building / A-Soft Analog Shell 2.0 / A-Soft Analog Shell 2.msi / Instal01.cab / _F8F9395FE96F11D3AD4F002018280775 < prev    next >
Encoding:
Text File  |  2000-02-21  |  9.6 KB  |  203 lines
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html> <head>
  3. <title>Readme for analog -- inclusions and exclusions</title>
  4. </head>
  5.  
  6. <body>
  7. [ <a href="Readme.html">Top</a> | <a href="custom.html">Up</a> |
  8. <a href="alias.html">Prev</a> | <a href="args.html">Next</a> |
  9. <a href="map.html">Map</a> | <a href="indx.html">Index</a> ]
  10. <h1>Readme for
  11. <a href="http://www.statslab.cam.ac.uk/~sret1/analog/">analog 4.03</a></h1>
  12. <h2>Inclusions and exclusions</h2>
  13.  
  14. After aliasing each item, analog decides whether that item is wanted or not.
  15. The whole line is only counted if all the items are wanted.
  16. Whether an item is wanted or not is determined by <kbd>INCLUDE</kbd> and
  17. <kbd>EXCLUDE</kbd> commands specified by the user. These commands can be used
  18. to exclude requests from your local users, for example, or to analyse only
  19. files in a subdirectory. For example
  20. <pre>
  21. HOSTEXCLUDE mycomputer.myisp.com
  22. </pre>
  23. would exclude all requests by that computer from the statistics.
  24. <p>
  25. The rule for determining whether an item is included or excluded is as
  26. follows. All the <kbd>INCLUDE</kbd> and <kbd>EXCLUDE</kbd> commands for that
  27. item are considered one by one in order, and the item is included or excluded
  28. according to the last command it matched. Items which don't match any of
  29. the <kbd>INCLUDE</kbd> or <kbd>EXCLUDE</kbd> commands are included if the first
  30. command was an exclusion, and excluded if the first command was an inclusion.
  31. For example, the configuration
  32. <pre>
  33. FILEINCLUDE /~sret1/*
  34. FILEEXCLUDE /~sret1/backgammon/*,/~sret1/analog/*
  35. FILEINCLUDE /~sret1/backgammon/*.gif
  36. </pre>
  37. would instruct the program to examine only my files, excluding my
  38. backgammon and analog files, but including gifs in my backgammon directory.
  39. On the other hand,
  40. <pre>
  41. FILEEXCLUDE /~sret1/*/img/*
  42. </pre>
  43. would analyse all files, except for images in my various directories. Note that
  44. inclusions and exclusions can contain any number of wildcards.
  45. <p>
  46. The full list of these commands is <kbd>HOSTINCLUDE</kbd> and
  47. <kbd>HOSTEXCLUDE</kbd>; <kbd>FILEINCLUDE</kbd> and <kbd>FILEXCLUDE</kbd>;
  48. <kbd>BROWINCLUDE</kbd> and <kbd>BROWEXCLUDE</kbd>; <kbd>REFINCLUDE</kbd> and
  49. <kbd>REFEXCLUDE</kbd>; <kbd>USERINCLUDE</kbd> and <kbd>USEREXCLUDE</kbd>; and
  50. <kbd>VHOSTINCLUDE</kbd> and <kbd>VHOSTEXCLUDE</kbd>.
  51. <p>
  52. Because the inclusions and exclusions take place <em>after</em> the aliasing,
  53. the name you must use is the aliased name. (In the absence of
  54. <kbd><a href="alias.html#OUTPUTALIAS">OUTPUTALIAS</a></kbd> commands, this is
  55. the name of the item in the output.)
  56. <p>
  57. Sometimes a line doesn't contain a particular sort of item, either because
  58. there is no field reserved for it on the line, or because the browser didn't
  59. send it for that request. You can include or exclude these lines by making a
  60. special blank entry in the <kbd>INCLUDE</kbd> or <kbd>EXCLUDE</kbd>
  61. command. For example,
  62. <pre>
  63. USERINCLUDE jim
  64. USERINCLUDE ""
  65. </pre>
  66. would include lines from user <kbd>jim</kbd> and lines without any user
  67. specified. 
  68. <p>
  69. The behaviour of <kbd>REQINCLUDE</kbd> and <kbd>REFINCLUDE</kbd> can be
  70. slightly unintuitive if the file has <a href="args.html#unintuitive">search
  71. arguments</a>.
  72. <p>
  73. <a name="incregexp">On suitable operating systems</a>, you can use regular
  74. expressions for the inclusions and exclusions by prefixing the expression with
  75. "<kbd>REGEXP:</kbd>" or "<kbd>REGEXPI:</kbd>". I've
  76. already described this at length in the context of aliases, so you can
  77. <a href="alias.html#aliasregexp">look there</a> for all the details.
  78. <p>
  79. If you get confused with all the inclusions and
  80. exclusions, remember that you can always run <kbd>analog -settings</kbd>
  81. to see what the options you have specified represent.
  82. <hr>
  83. <a name="FROMTO">There is also</a> one other pair of commands which belongs in
  84. this category,
  85. namely the <kbd>FROM</kbd> and <kbd>TO</kbd> commands. These specify a time
  86. period to restrict the analysis to. The simplest usage of these commands is
  87. <kbd>FROM yyMMdd</kbd> or <kbd>FROM yyMMdd:hhmm</kbd>, where <kbd>yy</kbd>
  88. represents the last two digits of the year (analog assumes that the year is
  89. between 1970 and 2069), <kbd>MM</kbd> represents the month,
  90. <kbd>dd</kbd> is the date, <kbd>hh</kbd> the hour, and <kbd>mm</kbd> the
  91. minute. So, for example, to analyse only requests from
  92. July 1999 to June 2000 I would use the configuration
  93. <pre>
  94. FROM 990701
  95. TO   000630
  96. </pre>
  97. Alternatively, each of the components can be preceded by <kbd>+</kbd> or
  98. <kbd>-</kbd> to represent time relative to the time at which the program was
  99. invoked. In this case, the date can have more than 2 digits. This allows
  100. constructions like
  101. <pre>
  102. FROM -01-00+01   # from tomorrow last year
  103. TO -00-0131  # to the end of last month (OK even if last month
  104.              # didn't have 31 days)
  105. FROM -00-00-112
  106. TO   -00-00-01  # statistics for the last 16 weeks
  107. FROM -00-00-00:-06+01  # statistics for the last 6 hours
  108. </pre>
  109. There are command line abbreviations <kbd>+F</kbd> and <kbd>+T</kbd>
  110. for the <kbd>FROM</kbd> and <kbd>TO</kbd> commands; for example,
  111. <kbd>+T-00-00-01:1800</kbd> looks at statistics until 6pm yesterday.
  112. <kbd>-F</kbd> and <kbd>-T</kbd> turn off the from and to, as do <kbd>FROM
  113. OFF</kbd> and <kbd>TO OFF</kbd>.
  114. <hr>
  115. <a name="outputexcludes">There are also</a> <kbd>INCLUDE</kbd> and
  116. <kbd>EXCLUDE</kbd> commands for most of
  117. the reports. These exclude individual lines from particular reports. So, for
  118. example, the command
  119. <pre>
  120. REFREPEXCLUDE http://your.site.com/*
  121. </pre>
  122. would exclude your internal referrers from the Referrer Report. However, it
  123. would not exclude them from the Failed Referrer Report, the Referring Site
  124. Report, etc. (you need to use <kbd>FAILREFEXCLUDE</kbd>,
  125. <kbd>REFSITEEXCLUDE</kbd> etc. for that); nor would it prevent other analysis
  126. of logfile lines with those referrers, as <kbd>REFEXCLUDE</kbd> would. Also
  127. <kbd>REFREPEXCLUDE</kbd> would include the referrers in the "not
  128. listed" line at the bottom of the report.
  129. <p>
  130. The full list of these commands is <kbd>REQINCLUDE</kbd> and
  131. <kbd>REQEXCLUDE</kbd>; <kbd>REDIRINCLUDE</kbd> and <kbd>REDIREXCLUDE</kbd>;
  132. <kbd>FAILINCLUDE</kbd> and <kbd>FAILEXCLUDE</kbd>; <kbd>TYPEINCLUDE</kbd> and
  133. <kbd>TYPEEXCLUDE</kbd>; <kbd>DIRINCLUDE</kbd> and <kbd>DIREXCLUDE</kbd>;
  134. <kbd>HOSTREPINCLUDE</kbd> and <kbd>HOSTREPEXCLUDE</kbd>; <kbd>DOMINCLUDE</kbd>
  135. and <kbd>DOMEXCLUDE</kbd>; <kbd>ORGINCLUDE</kbd> and <kbd>ORGEXCLUDE</kbd>;
  136. <kbd>REFREPINCLUDE</kbd> and
  137. <kbd>REFREPEXCLUDE</kbd>; <kbd>REFSITEINCLUDE</kbd> and
  138. <kbd>REFSITEEXCLUDE</kbd>; <kbd>SEARCHQUERYINCLUDE</kbd> and
  139. <kbd>SEARCHQUERYEXCLUDE</kbd>; <kbd>SEARCHWORDINCLUDE</kbd> and
  140. <kbd>SEARCHWORDEXCLUDE</kbd>; <kbd>REDIRREFINCLUDE</kbd> and
  141. <kbd>REDIRREFEXCLUDE</kbd>; <kbd>FAILREFINCLUDE</kbd> and
  142. <kbd>FAILREFEXCLUDE</kbd>; <kbd>BROWSUMINCLUDE</kbd> and
  143. <kbd>BROWSUMEXCLUDE</kbd>; <kbd>FULLBROWINCLUDE</kbd> and
  144. <kbd>FULLBROWEXCLUDE</kbd>; <kbd>OSINCLUDE</kbd> and <kbd>OSEXCLUDE</kbd>;
  145. <kbd>VHOSTREPINCLUDE</kbd> and
  146. <kbd>VHOSTREPEXCLUDE</kbd>; <kbd>USERREPINCLUDE</kbd> and
  147. <kbd>USERREPEXCLUDE</kbd>; and <kbd>FAILUSERINCLUDE</kbd> and
  148. <kbd>FAILUSEREXCLUDE</kbd>. The inclusion or exclusion applies to the
  149. unaliased name, if you are doing any <a href="alias.html#OUTPUTALIAS">output
  150. aliases</a>.
  151. <p>
  152. <!-- not just in output IN/EXCLUDEs, although the layout of this text might -->
  153. <!-- imply that so as to present REQINCLUDE pages in the right place -->
  154. You can also use the symbolic word <kbd>pages</kbd> in suitable
  155. <kbd>INCLUDE</kbd> and <kbd>EXCLUDE</kbd> commands; one very common command is
  156. <pre>
  157. REQINCLUDE pages
  158. </pre>
  159. to include only pages in the request report.
  160. <hr>
  161. <a name="PAGEINCLUDE">Analog determines</a> which files should count as pages
  162. (and thus which requests
  163. count as page requests) using another <kbd>INCLUDE</kbd>/<kbd>EXCLUDE</kbd>
  164. pair, called <kbd>PAGEINCLUDE</kbd> and <kbd>PAGEEXCLUDE</kbd>.
  165. By default, <kbd>*.html</kbd>, <kbd>*.htm</kbd> and directories (<kbd>*/</kbd>)
  166. count as pages. But you change the list by commands like
  167. <pre>
  168. PAGEINCLUDE *.ps,*.ps.gz
  169. PAGEEXCLUDE /sret1.html
  170. </pre>
  171. I.e., Postscript and gzipped Postscript are pages, but <kbd>/sret1.html</kbd>
  172. isn't. (If the file has <a href="args.html">search arguments</a>, the
  173. <kbd>PAGEINCLUDE</kbd> and <kbd>PAGEEXCLUDE</kbd> are reckoned just on the
  174. part of the filename before the question mark.)
  175. <hr>
  176. <a name="LINKINCLUDE">There is one more</a> set of <kbd>INCLUDE</kbd> and
  177. <kbd>EXCLUDE</kbd> commands which I'll describe now. In the Request Report
  178. and the three referrer reports (Referrer Report, Redirected Referrer Report
  179. and Failed Referrer Report), analog can link to the files which it's
  180. listing. There are commands <kbd>LINKINCLUDE</kbd> and <kbd>LINKEXCLUDE</kbd>
  181. for the Request Report, and <kbd>REFLINKINCLUDE</kbd> and
  182. <kbd>REFLINKEXCLUDE</kbd> for the referrer reports, to specify exactly which
  183. files are linked to. So, for example,
  184. <kbd>
  185. REFLINKINCLUDE pages
  186. </kbd>
  187. would link to pages in the three referrer reports.
  188. <hr>
  189. There is one final set of <kbd>INCLUDE</kbd> and <kbd>EXCLUDE</kbd> commands
  190. to include or exclude the search arguments at the end of URLs. But there are
  191. some slightly complicated issues surrounding those, so they deserve a
  192. <a href="args.html">new section</a>.
  193. <hr>
  194. <address><a HREF="http://www.statslab.cam.ac.uk/~sret1/">Stephen Turner</a>
  195. <br>Need help with analog? <a href="mailing.html">Subscribe to the analog-help
  196. mailing list</a>
  197. </address>
  198. <p>
  199. [ <a href="Readme.html">Top</a> | <a href="custom.html">Up</a> |
  200. <a href="alias.html">Prev</a> | <a href="args.html">Next</a> |
  201. <a href="map.html">Map</a> | <a href="indx.html">Index</a> ]
  202. </body> </html>
  203.